<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>DiscontinuousGalerkin: SquareTriangularGridManipulation Module Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">DiscontinuousGalerkin
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('class_square_triangular_grid_manipulation.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<div class="title">SquareTriangularGridManipulation Module Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="SquareTriangularGridManipulation" -->
<p><a href="module_square_triangular_grid_manipulation-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">type &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_square_triangular_grid_manipulation_1_1_square_triangular_grid.html">SquareTriangularGrid</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">pure integer function&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_square_triangular_grid_manipulation.html#aaf6e05d861021c1e65bd9f5e57f77465">numberOfElements</a> (this)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of elements of the grid.  <a href="#aaf6e05d861021c1e65bd9f5e57f77465"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">pure function&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_square_triangular_grid_manipulation.html#abe1a48da3d9911c9d925b6eb559f7cdd">numberOfBoundaryElements</a> (this)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of Boundary Elements of the grid.  <a href="#abe1a48da3d9911c9d925b6eb559f7cdd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_square_triangular_grid_manipulation.html#a5a2698974de2789f082d4b0e5a0a1d93">SetGridData</a> (this, Lx, Ly, Nelx, Nely, Basex, Basey)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the dimensional data for the grid.  <a href="#a5a2698974de2789f082d4b0e5a0a1d93"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95adc7869efd8ec72c4c2de907d9217d"></a><!-- doxytag: member="SquareTriangularGridManipulation::GenerateStructuredGrid" ref="a95adc7869efd8ec72c4c2de907d9217d" args="(this)" -->
subroutine&#160;</td><td class="memItemRight" valign="bottom"><b>GenerateStructuredGrid</b> (this)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_square_triangular_grid_manipulation.html#aa5cd0bf56d688d533a75b6a260d1fc54">GenerateNodes</a> (this)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate the Grid Points with a Rectangular-Regular aspect.  <a href="#aa5cd0bf56d688d533a75b6a260d1fc54"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_square_triangular_grid_manipulation.html#adf59919241473956bf4992d6526ccc67">GenerateElements</a> (this)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate the data structures for the elements of the region.  <a href="#adf59919241473956bf4992d6526ccc67"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_square_triangular_grid_manipulation.html#a8bd53345cef65b271e72f528810bc886">GenerateNeighbours</a> (this)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate the Neighbours for the Elements on the Grid. It does not include the Ghost Elements on the Boundary.  <a href="#a8bd53345cef65b271e72f528810bc886"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5116684d42ce1a47448f6183866a6851"></a><!-- doxytag: member="SquareTriangularGridManipulation::GenerateBoundaryEdges" ref="a5116684d42ce1a47448f6183866a6851" args="(this)" -->
subroutine&#160;</td><td class="memItemRight" valign="bottom"><b>GenerateBoundaryEdges</b> (this)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">function&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_square_triangular_grid_manipulation.html#a4ae92a8d65bdf0bd4e632fbd2538e36a">GhostTriangle</a> (boundaryElement, sharedEdge)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return A Ghost Boundary Element Without any Degrees-of-Freedom setted.  <a href="#a4ae92a8d65bdf0bd4e632fbd2538e36a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3337bb9e6f06cb3aac125c4f34aae8e"></a><!-- doxytag: member="SquareTriangularGridManipulation::SetGhostData_Convection" ref="ad3337bb9e6f06cb3aac125c4f34aae8e" args="(Ghost, BoundaryElement, sharedEdge, convectionFactor, EnvironmentTemperature)" -->
subroutine&#160;</td><td class="memItemRight" valign="bottom"><b>SetGhostData_Convection</b> (Ghost, BoundaryElement, sharedEdge, convectionFactor, EnvironmentTemperature)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab40a753ab1d1533eb377b55b518383a0"></a><!-- doxytag: member="SquareTriangularGridManipulation::SetGhostData_PrescribedTemperature" ref="ab40a753ab1d1533eb377b55b518383a0" args="(Ghost, BoundaryElement, sharedEdge, Temperature)" -->
subroutine&#160;</td><td class="memItemRight" valign="bottom"><b>SetGhostData_PrescribedTemperature</b> (Ghost, BoundaryElement, sharedEdge, Temperature)</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2ed4fba88e8621e49ae15ae663a150e"></a><!-- doxytag: member="SquareTriangularGridManipulation::numberOfBoundaries" ref="ab2ed4fba88e8621e49ae15ae663a150e" args="" -->
integer, parameter&#160;</td><td class="memItemRight" valign="bottom"><b>numberOfBoundaries</b> = 4</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0637d6645ecf5fdadf2ef9118b38ff13"></a><!-- doxytag: member="SquareTriangularGridManipulation::prescribedTemperatureBoundary" ref="a0637d6645ecf5fdadf2ef9118b38ff13" args="" -->
integer, parameter&#160;</td><td class="memItemRight" valign="bottom"><b>prescribedTemperatureBoundary</b> = 1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae28f879bdae6d228ca48dbd896ad1d9b"></a><!-- doxytag: member="SquareTriangularGridManipulation::prescribedHeatFluxBoundary" ref="ae28f879bdae6d228ca48dbd896ad1d9b" args="" -->
integer, parameter&#160;</td><td class="memItemRight" valign="bottom"><b>prescribedHeatFluxBoundary</b> = 2</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d0afd6e725f6fa9d00be7a487e0c160"></a><!-- doxytag: member="SquareTriangularGridManipulation::convectionBoundary" ref="a1d0afd6e725f6fa9d00be7a487e0c160" args="" -->
integer, parameter&#160;</td><td class="memItemRight" valign="bottom"><b>convectionBoundary</b> = 3</td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adf59919241473956bf4992d6526ccc67"></a><!-- doxytag: member="SquareTriangularGridManipulation::GenerateElements" ref="adf59919241473956bf4992d6526ccc67" args="(this)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">subroutine SquareTriangularGridManipulation::GenerateElements </td>
          <td>(</td>
          <td class="paramtype">type(SquareGrid), intent(inout)&#160;</td>
          <td class="paramname"><em>this</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Generate the data structures for the elements of the region. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">this</td><td>- The Grid data structure </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a8bd53345cef65b271e72f528810bc886"></a><!-- doxytag: member="SquareTriangularGridManipulation::GenerateNeighbours" ref="a8bd53345cef65b271e72f528810bc886" args="(this)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">subroutine SquareTriangularGridManipulation::GenerateNeighbours </td>
          <td>(</td>
          <td class="paramtype">type(SquareGrid), intent(inout)&#160;</td>
          <td class="paramname"><em>this</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Generate the Neighbours for the Elements on the Grid. It does not include the Ghost Elements on the Boundary. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">this</td><td>- The Grid data structure </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aa5cd0bf56d688d533a75b6a260d1fc54"></a><!-- doxytag: member="SquareTriangularGridManipulation::GenerateNodes" ref="aa5cd0bf56d688d533a75b6a260d1fc54" args="(this)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">subroutine SquareTriangularGridManipulation::GenerateNodes </td>
          <td>(</td>
          <td class="paramtype">type(<a class="el" href="struct_square_triangular_grid_manipulation_1_1_square_triangular_grid.html">SquareTriangularGrid</a>), intent(inout)&#160;</td>
          <td class="paramname"><em>this</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Generate the Grid Points with a Rectangular-Regular aspect. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">this</td><td>- The Grid data Structure </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a4ae92a8d65bdf0bd4e632fbd2538e36a"></a><!-- doxytag: member="SquareTriangularGridManipulation::GhostTriangle" ref="a4ae92a8d65bdf0bd4e632fbd2538e36a" args="(boundaryElement, sharedEdge)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function SquareTriangularGridManipulation::GhostTriangle </td>
          <td>(</td>
          <td class="paramtype">type(TriangleElement), intent(in)&#160;</td>
          <td class="paramname"><em>boundaryElement</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">integer, dimension(2), intent(in)&#160;</td>
          <td class="paramname"><em>sharedEdge</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return A Ghost Boundary Element Without any Degrees-of-Freedom setted. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">\param</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>

</div>
</div>
<a class="anchor" id="abe1a48da3d9911c9d925b6eb559f7cdd"></a><!-- doxytag: member="SquareTriangularGridManipulation::numberOfBoundaryElements" ref="abe1a48da3d9911c9d925b6eb559f7cdd" args="(this)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">pure function SquareTriangularGridManipulation::numberOfBoundaryElements </td>
          <td>(</td>
          <td class="paramtype">type(<a class="el" href="struct_square_triangular_grid_manipulation_1_1_square_triangular_grid.html">SquareTriangularGrid</a>), intent(in)&#160;</td>
          <td class="paramname"><em>this</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return the number of Boundary Elements of the grid. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">this</td><td>- The triangular square grid of the </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>n - the number of elements on the boundary </dd></dl>

</div>
</div>
<a class="anchor" id="aaf6e05d861021c1e65bd9f5e57f77465"></a><!-- doxytag: member="SquareTriangularGridManipulation::numberOfElements" ref="aaf6e05d861021c1e65bd9f5e57f77465" args="(this)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">pure integer function SquareTriangularGridManipulation::numberOfElements </td>
          <td>(</td>
          <td class="paramtype">type(<a class="el" href="struct_square_triangular_grid_manipulation_1_1_square_triangular_grid.html">SquareTriangularGrid</a>), intent(in)&#160;</td>
          <td class="paramname"><em>this</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return the number of elements of the grid. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">this</td><td>- The triangular square grid of the </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>n - the number of elements </dd></dl>

</div>
</div>
<a class="anchor" id="a5a2698974de2789f082d4b0e5a0a1d93"></a><!-- doxytag: member="SquareTriangularGridManipulation::SetGridData" ref="a5a2698974de2789f082d4b0e5a0a1d93" args="(this, Lx, Ly, Nelx, Nely, Basex, Basey)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">subroutine SquareTriangularGridManipulation::SetGridData </td>
          <td>(</td>
          <td class="paramtype">type(SquareGrid), intent(out)&#160;</td>
          <td class="paramname"><em>this</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind=8), intent(in)&#160;</td>
          <td class="paramname"><em>Lx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind=8), intent(in)&#160;</td>
          <td class="paramname"><em>Ly</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">integer, intent(in)&#160;</td>
          <td class="paramname"><em>Nelx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">integer, intent(in)&#160;</td>
          <td class="paramname"><em>Nely</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind=8), intent(in)&#160;</td>
          <td class="paramname"><em>Basex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind=8), intent(in)&#160;</td>
          <td class="paramname"><em>Basey</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set the dimensional data for the grid. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">this</td><td>- The Grid data structure </td></tr>
    <tr><td class="paramname">Lx</td><td>- The Length on the X Axis </td></tr>
    <tr><td class="paramname">Ly</td><td>- The Length on the Y Axis </td></tr>
    <tr><td class="paramname">Nelx</td><td>- The Number of elements over the X Axis </td></tr>
    <tr><td class="paramname">Nely</td><td>- The Number of elements over the Y Axis </td></tr>
    <tr><td class="paramname">Basex</td><td>- The Spatial Position of the Bottom-Leftest point on the X Axis </td></tr>
    <tr><td class="paramname">Basey</td><td>- The Spatial Position of the Bottom-Leftest point on the Y Axis </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this module was generated from the following file:<ul>
<li>SquareTriangularGrid.f90</li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="class_square_triangular_grid_manipulation.html">SquareTriangularGridManipulation</a>      </li>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


    <li class="footer">Generated on Wed May 23 2012 14:51:36 for DiscontinuousGalerkin by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
